home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / os2 / e33el2.zip / emacs / 19.33 / lisp / avoid.el < prev    next >
Lisp/Scheme  |  1996-05-23  |  15KB  |  360 lines
  1. ;;; avoid.el --- make mouse pointer stay out of the way of editing
  2.  
  3. ;;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu>
  6. ;; Keywords: mouse
  7.  
  8. ;; This file is part of GNU Emacs.
  9.  
  10. ;; GNU Emacs is free software; you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation; either version 2, or (at your option)
  13. ;; any later version.
  14.  
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18. ;; GNU General Public License for more details.
  19.  
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23. ;; Boston, MA 02111-1307, USA.
  24.  
  25. ;;; Commentary:
  26.  
  27. ;; For those who are annoyed by the mouse pointer obscuring text,
  28. ;; this mode moves the mouse pointer - either just a little out of
  29. ;; the way, or all the way to the corner of the frame. 
  30. ;; To use, load or evaluate this file and type M-x mouse-avoidance-mode .
  31. ;; To set up permanently, put the following in your .emacs: 
  32. ;;
  33. ;; (if window-system (mouse-avoidance-mode 'animate))
  34. ;;
  35. ;; The 'animate can be 'jump or 'banish or 'exile or 'protean if you prefer.
  36. ;; See the documentation for function `mouse-avoidance-mode' for
  37. ;; details of the different modes.
  38. ;;
  39. ;; For added silliness, make the animatee animate...
  40. ;; put something similar to the following into your .emacs:
  41. ;;
  42. ;; (if window-system
  43. ;;     (mouse-avoidance-set-pointer-shape
  44. ;;         (eval (nth (random 4)
  45. ;;            '(x-pointer-man x-pointer-spider
  46. ;;              x-pointer-gobbler x-pointer-gumby)))))
  47. ;;
  48. ;; For completely random pointer shape, replace the setq above with:
  49. ;; (setq x-pointer-shape (mouse-avoidance-random-shape))
  50. ;; 
  51. ;; Bugs / Warnings / To-Do:
  52. ;;
  53. ;; - Using this code does slow emacs down.  "banish" mode shouldn't
  54. ;;   be too bad, and on my workstation even "animate" is reasonable.
  55. ;;
  56. ;; - It ought to find out where any overlapping frames are and avoid them,
  57. ;;   rather than always raising the frame.
  58.  
  59. ;; Credits:
  60. ;; This code was helped by all those who contributed suggestions, 
  61. ;;   fixes, and additions
  62. ;; Joe Harrington (and his advisor), for the original inspiration.
  63. ;; Ken Manheimer, for dreaming up the Protean mode.
  64. ;; Richard Stallman, for the awful cat-and-mouse pun, among other things.
  65. ;; Mike Williams, Denis Howe, Bill Benedetto, Chris Moore, Don Morris,
  66. ;; Simon Marshall, and M.S. Ashton, for their feedback.
  67.  
  68. ;;; Code:
  69.  
  70. (provide 'avoid)
  71.  
  72. (defvar mouse-avoidance-mode nil
  73.   "Value is t or a symbol if the mouse pointer should avoid the cursor.
  74. See function `mouse-avoidance-mode' for possible values.  Changing this
  75. variable is NOT the recommended way to change modes; use that function 
  76. instead.")
  77.  
  78. (defvar mouse-avoidance-nudge-dist 15
  79.   "*Average distance that mouse will be moved when approached by cursor.
  80. Only applies in mouse-avoidance-mode `jump' and its derivatives.
  81. For best results make this larger than `mouse-avoidance-threshold'.")
  82.  
  83. (defvar mouse-avoidance-nudge-var 10
  84.   "*Variability of `mouse-avoidance-nudge-dist' (which see).")
  85.  
  86. (defvar mouse-avoidance-animation-delay .01
  87.   "Delay between animation steps, in seconds.")
  88.  
  89. (defvar mouse-avoidance-threshold 5
  90.   "*Mouse-pointer's flight distance.
  91. If the cursor gets closer than this, the mouse pointer will move away.
  92. Only applies in mouse-avoidance-modes `animate' and `jump'.")
  93.  
  94. ;; Internal variables
  95. (defvar mouse-avoidance-state nil)
  96. (defvar mouse-avoidance-pointer-shapes nil)
  97. (defvar mouse-avoidance-n-pointer-shapes 0)
  98. (defvar mouse-avoidance-old-pointer-shape nil)
  99.  
  100. ;;; Functions:
  101.  
  102. (defsubst mouse-avoidance-set-pointer-shape (shape)
  103.   "Set the shape of the mouse pointer to SHAPE."
  104.   (setq x-pointer-shape shape)
  105.   (set-mouse-color nil))
  106.  
  107. (defun mouse-avoidance-point-position ()
  108.   "Return the position of point as (FRAME X . Y).
  109. Analogous to mouse-position."
  110.   (let* ((w (selected-window))
  111.      (edges (window-edges w))
  112.      (list 
  113.       (compute-motion (max (window-start w) (point-min))   ; start pos
  114.               ;; window-start can be < point-min if the
  115.               ;; latter has changed since the last redisplay 
  116.               '(0 . 0)                           ; start XY
  117.               (point)                           ; stop pos
  118.               (cons (window-width) (window-height)); stop XY: none
  119.               (1- (window-width))                  ; width
  120.               (cons (window-hscroll w) 0)          ; 0 may not be right?
  121.               (selected-window))))
  122.     ;; compute-motion returns (pos HPOS VPOS prevhpos contin)
  123.     ;; we want:               (frame hpos . vpos)
  124.     (cons (selected-frame)
  125.       (cons (+ (car edges)       (car (cdr list)))
  126.         (+ (car (cdr edges)) (car (cdr (cdr list))))))))
  127.  
  128. ;(defun mouse-avoidance-point-position-test ()
  129. ;  (interactive)
  130. ;  (message (format "point=%s mouse=%s" 
  131. ;           (cdr (mouse-avoidance-point-position))
  132. ;           (cdr (mouse-position)))))
  133.  
  134. (defun mouse-avoidance-set-mouse-position (pos)
  135.   ;; Carefully set mouse position to given position (X . Y)
  136.   ;; Ideally, should check if X,Y is in the current frame, and if not,
  137.   ;; leave the mouse where it was.  However, this is currently
  138.   ;; difficult to do, so we just raise the frame to avoid frame switches.
  139.   ;; Returns t if it moved the mouse.
  140.   (let ((f (selected-frame)))
  141.     (raise-frame f)
  142.     (set-mouse-position f (car pos) (cdr pos))
  143.     t))
  144.       
  145. (defun mouse-avoidance-too-close-p (mouse)
  146.   ;;  Return t if mouse pointer and point cursor are too close.
  147.   ;; Acceptable distance is defined by mouse-avoidance-threshold.
  148.   (let ((point (mouse-avoidance-point-position)))
  149.     (and (eq (car mouse) (car point))
  150.      (car (cdr mouse))
  151.      (< (abs (- (car (cdr mouse)) (car (cdr point))))
  152.         mouse-avoidance-threshold)
  153.      (< (abs (- (cdr (cdr mouse)) (cdr (cdr point))))
  154.         mouse-avoidance-threshold))))
  155.  
  156. (defun mouse-avoidance-banish-destination ()
  157.   "The position to which mouse-avoidance-mode `banish' moves the mouse.
  158. You can redefine this if you want the mouse banished to a different corner."
  159.  (cons (1- (frame-width))
  160.        0))
  161.  
  162. (defun mouse-avoidance-banish-mouse ()
  163.   ;; Put the mouse pointer in the upper-right corner of the current frame.
  164.   (mouse-avoidance-set-mouse-position (mouse-avoidance-banish-destination)))
  165.  
  166. (defsubst mouse-avoidance-delta (cur delta dist var min max)
  167.   ;; Decide how far to move in either dimension.
  168.   ;; Args are the CURRENT location, the desired DELTA for
  169.   ;; warp-conservation, the DISTANCE we like to move, the VARIABILITY
  170.   ;; in distance allowed, and the MIN and MAX possible window positions.
  171.   ;; Returns something as close to DELTA as possible within the constraints.
  172.   (let ((L1 (max (- min cur) (+ (- dist) (- var))))
  173.     (R1                  (+ (- dist)    var ))
  174.     (L2                  (+    dist  (- var)))
  175.     (R2 (min (- max cur) (+    dist     var))))
  176.     (if (< R1 (- min cur)) (setq L1 nil R1 nil))
  177.     (if (> L2 (- max cur)) (setq L2 nil R2 nil))
  178.     (cond ((and L1 (< delta L1)) L1)
  179.       ((and R1 (< delta R1)) delta)
  180.       ((and R1 (< delta 0)) R1)
  181.       ((and L2 (< delta L2)) L2)
  182.       ((and R2 (< delta R2)) delta)
  183.       (R2)
  184.       ((or R1 L2))
  185.       (t 0))))
  186.  
  187. (defun mouse-avoidance-nudge-mouse () 
  188.   ;; Push the mouse a little way away, possibly animating the move
  189.   ;; For these modes, state keeps track of the total offset that we've
  190.   ;; accumulated, and tries to keep it close to zero.
  191.   (let* ((cur (mouse-position))
  192.      (cur-frame (car cur))
  193.      (cur-pos (cdr cur))
  194.      (deltax (mouse-avoidance-delta 
  195.           (car cur-pos) (- (random mouse-avoidance-nudge-var)
  196.                    (car mouse-avoidance-state))
  197.           mouse-avoidance-nudge-dist mouse-avoidance-nudge-var
  198.           0 (frame-width)))
  199.      (deltay (mouse-avoidance-delta 
  200.           (cdr cur-pos) (- (random mouse-avoidance-nudge-var)
  201.                    (cdr mouse-avoidance-state))
  202.           mouse-avoidance-nudge-dist mouse-avoidance-nudge-var
  203.           0 (frame-height))))
  204.     (setq